Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 31, 2025

Link issues

fixes #6512

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Refactor the message display logic to properly clear and update existing message items when reusing the same option, cancel pending animations, and improve the sample usage to reflect the updated behavior.

Bug Fixes:

  • Prevent duplicate message items by reusing existing entries when showing messages with the same ID
  • Cancel pending auto-hide animations before re-displaying the same message

Enhancements:

  • Update sample code to demonstrate auto-hide and color changes in the message demo

@bb-auto bb-auto bot added the enhancement New feature or request label Jul 31, 2025
@bb-auto bb-auto bot added this to the 9.8.0 milestone Jul 31, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 31, 2025

Reviewer's Guide

This PR refactors the Message component to reuse existing message entries when invoked with the same options—canceling any pending animations to prevent duplicates—and updates the sample page to correct message color and auto-hide behavior.

Class diagram for updated Message item management in Message.razor.js

classDiagram
    class Message {
        +items: Array<MessageItem>
        +show(id, msgId)
    }
    class MessageItem {
        +el
        +animationId
    }
    Message o-- "*" MessageItem: contains
Loading

File-Level Changes

Change Details Files
Refactor show() in Message.razor.js to handle repeated invocations correctly
  • Look up msgItem by element id and only push a new one if not found
  • Cancel any existing animationFrame on the msgItem before scheduling auto-hide
  • Retain existing behavior for auto-hide timing and callback invocation
src/BootstrapBlazor/Components/Message/Message.razor.js
Update sample Messages.razor.cs to correct message color and auto-hide timing
  • Change the first message color from Info to Primary
  • Move enabling of IsAutoHide from the second to the third message demonstration
src/BootstrapBlazor.Server/Components/Samples/Messages.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6512 Ensure that when the Message component is shown with the same option (i.e., same msgId), the previous message is cleared before displaying the new one.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ArgoZhang ArgoZhang added bug Something isn't working and removed enhancement New feature or request labels Jul 31, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jul 31, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

  • Instead of using msg.items.pop(), remove the specific msgItem (e.g. via filter or splice) so you don’t accidentally drop the wrong entry when multiple messages are active.
  • You cancel only the animation frame for an existing msgItem but not the auto-hide timeout—consider storing the hideHandler on msgItem and clearing it when reusing the same message to prevent stale timeouts from firing.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Instead of using msg.items.pop(), remove the specific msgItem (e.g. via filter or splice) so you don’t accidentally drop the wrong entry when multiple messages are active.
- You cancel only the animation frame for an existing msgItem but not the auto-hide timeout—consider storing the hideHandler on msgItem and clearing it when reusing the same message to prevent stale timeouts from firing.

## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor/Components/Message/Message.razor.js:23` </location>
<code_context>
+        msg.items.push(msgItem)
+    }

+    if (msgItem.animationId) {
+        cancelAnimationFrame(msgItem.animationId);
+    }
+
</code_context>

<issue_to_address>
Consider resetting animationId after cancelAnimationFrame.

Setting msgItem.animationId to null or undefined after cancellation clarifies its state and helps prevent accidental reuse.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    if (msgItem.animationId) {
        cancelAnimationFrame(msgItem.animationId);
    }
=======
    if (msgItem.animationId) {
        cancelAnimationFrame(msgItem.animationId);
        msgItem.animationId = null;
    }
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `src/BootstrapBlazor/Components/Message/Message.razor.js:51` </location>
<code_context>
         const hideHandler = setTimeout(function () {
             clearTimeout(hideHandler);

-            // remove Id
             msg.items.pop();
             if (msg.items.length === 0) {
-                // call server method prepare remove dom
</code_context>

<issue_to_address>
Using pop() may not remove the intended message item.

msg.items.pop() removes the last item, which may not be the correct message if multiple are present. Remove the specific msgItem to ensure accuracy.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jul 31, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (a296a6d) to head (5cc5865).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6513   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          714       714           
  Lines        31387     31387           
  Branches      4430      4430           
=========================================
  Hits         31387     31387           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(Message): should clear when use same option

2 participants